home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2000 January / Macworld (2000-01).dmg / Mac OS 9 Updaters / Shareware / ramBunctious 1.3.2 / ramBunctious Manual < prev    next >
Text File  |  1999-10-19  |  26KB  |  495 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                             ramBunctious 1.3.2
  9.  
  10.               copyright © 1995 - 1999 by Clarkwood Software
  11.  
  12.  ramBunctious is a RAM disk program for the Macintosh. ramBunctious
  13.  maintains the advantages and eliminates the disadvantages of other RAM
  14.  disk programs. ramBunctious is a shareware program. It is not
  15.  crippleware.
  16.  
  17.  A full set of HTML documentation is available at the ramBunctious web
  18.  site. We recommend that you visit the site for the most updated, easy
  19.  to use version of the ramBunctious documentation.
  20.  
  21.  <http://www.clarkwoodsoftware.com/rambunctious/>
  22.  
  23.  If you have questions or comments, email the authors at:
  24.  
  25.  rambunctious@clarkwoodsoftware.com
  26.  
  27.  
  28.  -----------------------------------------------------------------------
  29.  
  30.                             Features and Usage
  31.  
  32.  ramBunctious is a RAM disk program with a rich set of features.
  33.  
  34.  ramBunctious maintains the advantages and eliminates the disadvantages
  35.  of most RAM disk programs. Several options let you customize for your
  36.  desired balance of speed, security, safety, and versatility. For
  37.  example, you can set it to write through to a file on a (real) disk for
  38.  safety in the event of a crash. You can mount as many RAM disks as you
  39.  wish (or as many as you have memory for) simultaneously. ramBunctious
  40.  uses the same memory that applications use, so the memory used for each
  41.  RAM disk is instantly available for other applications when the RAM
  42.  disk is put away.
  43.  
  44.  Its menus, dialogs, and windows allow easy management of your RAM
  45.  disks, whether you use a single RAM disk or multiple RAM disks with
  46.  customized settings for each.
  47.  
  48.  When you create a RAM disk, you can specify initial settings. These
  49.  settings can be adjusted later using the RAM disk's settings window,
  50.  and are discussed below.
  51.  
  52.  When you select "New RAM Disk..." from the File menu, a standard file
  53.  dialog is presented.
  54.  
  55.  In addition to the standard controls to navigate and enter a RAM disk
  56.  name, there are a few extra controls.
  57.  
  58.  The popup menu allows you to choose the size of your RAM disk. There
  59.  are several pre-selected values, and you can enter any value by
  60.  choosing "Other..."
  61.  
  62.  If Startup Items Folder is selected, a folder called "Startup Items"
  63.  will be created automatically on your new RAM disk. Any files (or
  64.  aliases) in this folder will be automatically opened when the RAM disk
  65.  is mounted. This powerful feature allows you to conveniently open
  66.  documents or applications when you start your RAM disk.
  67.  
  68.  The Open Status Window control determines if the settings window for
  69.  the new RAM disk will be visible initially. This is only a convenience
  70.  option, because you can always open and close the settings window after
  71.  the RAM disk is mounted.
  72.  
  73.  The Automount Volume feature lets you start up your computer with a RAM
  74.  disk already mounted. It works by automatically placing an alias to the
  75.  new file in the startup items folder of the System folder.
  76.  
  77.  The RAM-only Volume checkbox lets you create a RAM disk without all the
  78.  contents in an image file.
  79.  
  80.  All of these options can be adjusted after the RAM disk is created --
  81.  they exist here only for convenience while creating the RAM disk.
  82.  
  83.  ramBunctious has a fairly simple File menu.
  84.  
  85.  New RAM disk... prompts for a new RAM disk name and size; it then
  86.  mounts the new volume, and makes it available for system use.
  87.  
  88.  Open... allows you to select a RAM disk image file; the RAM disk is
  89.  mounted and available for normal use.
  90.  
  91.  Close closes the frontmost RAM disk settings window.
  92.  
  93.  Save performs a write-through for the RAM disk whose window is in
  94.  front.
  95.  
  96.  Put Away unmounts the RAM disk whose window is in front.
  97.  
  98.  Register auto-launches the Register program to assist registering
  99.  ramBunctious.
  100.  
  101.  Quit tries to put away all open RAM disks and exits the ramBunctious
  102.  application.
  103.  
  104.  The RAM Disk menu lets you manipulate mounted RAM disks.
  105.  
  106.  When you select a RAM disk from the Put Away submenu, the selected RAM
  107.  disk will be put away (unless it contains open files). There are three
  108.  independent ways to put away RAM disks when you're done with them: you
  109.  can use this Put Away submenu; you can quit ramBunctious; finally, you
  110.  can put away the volume from Finder.
  111.  
  112.  Each mounted RAM disk has an item in the RAM disk menu; a check mark
  113.  next to it indicates that its window is open. To open a RAM disk's
  114.  window, select the item. If you select an item with a check mark
  115.  already next to it, that window is brought to the front.
  116.  
  117.  The features of ramBunctious include:
  118.  
  119.     * You can have multiple RAM disks mounted simultaneously, limited
  120.       only by memory available.
  121.     * ramBunctious has a "write-through" option. When activated,
  122.       everything written to the RAM disk is saved to a (real) file. This
  123.       means that the next time you mount the RAM disk, all the contents
  124.       are still there. It also adds protection against data loss in the
  125.       event of a crash.
  126.     * ramBunctious uses normal application memory. This means that when
  127.       you're done using a RAM disk, that memory is available for other
  128.       applications to use. In other words, you don't have to reboot to
  129.       regain the memory.
  130.     * A Startup Items folder on the RAM disk behaves like the Startup
  131.       Items folder in the System Folder, except that all the enclosed
  132.       items are opened when the RAM disk is mounted. You can put aliases
  133.       to applications in this folder, and those applications will be
  134.       launched when the RAM disk is mounted.
  135.     * Each RAM disk may be configured to be mounted automatically when
  136.       the computer is started up.
  137.     * These options, and more, are fully user-configurable for each RAM
  138.       disk via a status/settings window:
  139.          o In addition to controls directing the behavior of the RAM
  140.            disk, this window includes indicators that flicker when the
  141.            RAM disk is being read from or written to:
  142.               + A "read" icon flickers during reads from the RAM disk.
  143.               + A "write" icon flickers during writes to the RAM disk.
  144.               + A "write-through" icon indicates when ramBunctious
  145.                 is writing recent changes to the RAM disk image
  146.                 file. (Write-through takes place only if the
  147.                 appropriate settings are active.) This icon has another
  148.                 purpose as well; when the RAM disk has information that
  149.                 has not been written to the RAM disk image file, the
  150.                 write-through icon is filled. This means that the RAM
  151.                 disk is "dirty" and the next time a write-through
  152.                 happens, it will update the RAM disk image file.
  153.            These indicators are similar to the access LEDs found on many
  154.            hard drives. The latch control allows you to shrink a
  155.            settings window so only the indicators are visible, or expand
  156.            the settings window to adjust the options.
  157.  
  158.          o The help icon toggles balloon help. Use balloon help to
  159.            clarify features of ramBunctious.
  160.          o If Ram-only volume is selected, no information on the volume
  161.            is saved to disk; it's all lost when you put away the RAM
  162.            disk.
  163.          o Disk-based volume specifies that a RAM disk image file holds
  164.            the RAM disk contents. There are various options for
  165.            maintaining RAM disk image files.
  166.          o Write-through means that after information is written to the
  167.            RAM disk, it is written "through" to the RAM disk image file.
  168.            The benefit of write-through is that if your computer
  169.            crashes, you won't lose information: it's written to a "real"
  170.            file after it's written to the RAM disk, making it safer than
  171.            other RAM disks.
  172.          o Save at quit means that all changes to the RAM disk are
  173.            remembered; then, when the RAM disk is put away, it writes
  174.            all the changes to the RAM disk image file.
  175.          o Ignore changes is a way to take a "snapshot" of the current
  176.            RAM disk. In the future, when this RAM disk is mounted, its
  177.            contents will be exactly what they were when you took the
  178.            snapshot: subsequent changes will not be recorded to the RAM
  179.            disk image file.
  180.          o N Minute Saves is a popup menu that lets you choose to save
  181.            periodically to the RAM disk image file. It will also save
  182.            when the RAM disk is put away.
  183.          o You can click the Save Now button any time the RAM disk is
  184.            "dirty" -- any time it has information that has not been
  185.            written through to the RAM disk image file.
  186.          o The Automount Volume feature lets you start up your computer
  187.            with a RAM disk already mounted. It works by automatically
  188.            placing an alias to the RAM disk image file in the startup
  189.            items folder of your startup disk's System folder.
  190.  
  191.  ramBunctious can be fully controlled by using AppleScript. For more
  192.  information, see the ramBunctious dictionary (from AppleScript) and
  193.  the example scripts included when you download ramBunctious.
  194.  
  195.    ------------------------------------------------------------------------
  196.  
  197.                             Frequently Asked Questions
  198.  
  199.       Q. I'm having trouble creating a RAM disk. Can you give instructions
  200.          for exactly how to create a RAM disk?
  201.       A. Here is a step-by-step description of how you can create a RAM disk.
  202.  
  203.            1. Open the ramBunctious application.
  204.            2. Select "New RAM Disk..." from the File menu.
  205.            3. Enter the name for your RAM disk (and the associated RAM disk
  206.               image file).
  207.            4. You may edit the initial settings. There is a popup menu for
  208.               choosing common RAM disk sizes.
  209.            5. After you click "Save", the system will automatically format
  210.               the RAM disk and put it on your desktop.
  211.  
  212.          You now have successfully created a RAM disk.
  213.       ----------------------------------------------------------------------
  214.       Q. I'm trying to create a RAM disk for my Netscape cache. I've created
  215.          the RAM disk, but Netscape doesn't recognize it when I try to choose
  216.          a cache location in the Options/Network Preferences dialog.
  217.       A. Netscape caches must be some integral (1, 2, 3, ...) number of
  218.          megabytes. Try creating a RAM disk that's 1440K. That's one MB to
  219.          make Netscape happy, plus some "elbow room" for the invisible files
  220.          and other overhead that the Mac OS automatically puts on every disk.
  221.       ----------------------------------------------------------------------
  222.       Q. Performance is of the utmost importance to me. How can I make my
  223.          ramBunctious RAM disk as fast as possible?
  224.       A. A different way of looking at the issue is to explore what can slow
  225.          a ramBunctious RAM disk down.
  226.  
  227.          One factor that affects performance is the write-through feature. If
  228.          the RAM disk is not RAM-only -- that is, if it saves its contents to
  229.          a file on a (real) disk, the driver needs to remember what parts of
  230.          the RAM disk need to be updated. That's so it doesn't need to write
  231.          out all the contents. It only writes out the bits that have changed.
  232.  
  233.          Another factor in ramBunctious performance, particularly noticeable
  234.          with small chunk sizes, is the flickering LED-like access
  235.          indicators. If a settings window is open, then every time the RAM
  236.          disk is accessed, that flickering is drawn to the screen.
  237.  
  238.          Finally, if multiple RAM disks are on the desktop, a small amount of
  239.          time is spent figuring out which one is the one asking for
  240.          attention.
  241.  
  242.          To summarize, the fastest ramBunctious RAM disk is a single RAM-only
  243.          RAM disk with the settings window closed.
  244.       ----------------------------------------------------------------------
  245.       Q. Is there a way to use a ramBunctious RAM disk as a startup disk?
  246.       A. Unfortunately, no.
  247.  
  248.          In order to work around the limitation, you can try what several
  249.          ramBunctious users have done: set up a minimal Apple RAM disk to
  250.          start up from, then use ramBunctious RAM disks for all the stuff you
  251.          typically work on.
  252.  
  253.          The reason that ramBunctious cannot be used as a startup disk is
  254.          based on a crucial design decision we made. ramBunctious uses
  255.          temporary memory, also known as "Process Manager Heap" memory or
  256.          Multifinder memory.
  257.  
  258.          Some RAM disk programs (like Apple's RAM disk control panel) use
  259.          system memory -- high memory above BufPtr -- which enables them to
  260.          be used as startup disks.
  261.  
  262.          Here are some of the reasons for our decision to use temporary
  263.          memory for the RAM disks:
  264.  
  265.             * It allows the user to reclaim the memory by simply unmounting
  266.               the RAM disk; with RAM disks using memory above BufPtr, the
  267.               computer needs to be restarted to reclaim the RAM disk's
  268.               memory.
  269.             * We wanted to allow the user to have multiple RAM disks online
  270.               simultaneously. This was unfeasible using memory above BufPtr.
  271.       ----------------------------------------------------------------------
  272.       Q. Why use write-through? Doesn't that degrade the performance,
  273.          defeating the purpose of a RAM disk?
  274.       A. Writing through does cause a performance hit when writing to a RAM
  275.          disk, but it maintains a safe RAM disk image file by ensuring that
  276.          changes are written to a real disk file. Furthermore, reading from
  277.          the RAM disk is where the greatest benefit occurs, since reading
  278.          only looks at the RAM disk and has no need to access the RAM disk
  279.          image file. A typical real-world example is compiling and linking an
  280.          application. A compiler has to read all the files it compiles, some
  281.          repeatedly, and writes a relatively small amount. By enabling the
  282.          write-through feature of ramBunctious, your gain the advantage of
  283.          fast reads from a RAM disk while maintaining the security of having
  284.          new information in a real file on a real hard drive in the real
  285.          world.
  286.       ----------------------------------------------------------------------
  287.       Q. Can ramBunctious be used to feed the hungry, heal the sick, stop
  288.          wars, and guarantee equal justice for all?
  289.       A. Yes. But the explanation is complex; if we gave a full explanation,
  290.          the only people who would understand the answer would be you and us.
  291.       ----------------------------------------------------------------------
  292.       Q. What are some uses of ramBunctious?
  293.       A. We have found that users of ramBunctious use it in a variety of
  294.          ways, including:
  295.  
  296.             * Most web browsers use a cache to remember recently-visited
  297.               sites. Netscape (and Internet Explorer 2.1 and up) allows you
  298.               to choose where to put the cache. Using a RAM disk for a cache
  299.               allows virtually instantaneous access to web pages you've
  300.               previously visited. Furthermore, some versions of Netscape are
  301.               acessing the cache constantly, and using a RAM disk decreases
  302.               the irritation of this constant hard-drive chatter.
  303.             * Programmers use ramBunctious to speed up project builds. When a
  304.               project file and all the source code for a project are on a RAM
  305.               disk, the development system can use the lightning speed of the
  306.               RAM disk to drastically reduce the time required to build a
  307.               project.
  308.             * Some users like the security implications of a RAM disk. If the
  309.               RAM disk is not mounted, it is impossible to examine the disk;
  310.               no one can pry into folders, no one can load sensitive files,
  311.               and no one can undelete files.
  312.             * PowerBook users are often concerned with battery usage; a RAM
  313.               disk doesn't have the relatively high power requirements of a
  314.               hard drive.
  315.       ----------------------------------------------------------------------
  316.       Q. Are there any products known to be incompatible with ramBunctious?
  317.       A. As far as we know, ramBunctious doesn't trounce around doing skanky
  318.          things. There are, however, some conflicts with existing products.
  319.  
  320.             * MountImage causes problems with several installers and other
  321.               programs that need to eject disks. ramBunctious needs to
  322.               unmount RAM disks, and MountImage interferes with that
  323.               unmounting process. In fact, the author of MountImage has
  324.               announced that he no longer supports MountImage. ramBunctious
  325.               detects MountImage and refuses to run if MountImage is
  326.               installed. Apple's DiskCopy utility is an elegant replacement
  327.               for MountImage; it handles everything MountImage does without
  328.               conflicting with other applications.
  329.             * The LanRover extension seems to behave poorly with any
  330.               application that uses temporary memory (also known as
  331.               MultiFinder memory, or the "Process Manager Heap"); since
  332.               ramBunctious uses temporary memory for the RAM disks, the
  333.               LanRover extension often conflicts with ramBunctious. This
  334.               behavior has been seen with LanRover version 3.7.3.
  335.             * Norton Utilities 2.0 included a module called Directory
  336.               Assistant II that modified standard file dialogs. Their
  337.               modifications are incompatible with the ramBunctious "New"
  338.               dialog. To create new RAM disks with ramBunctious, restart the
  339.               computer with extensions disabled (hold "shift" down), or
  340.               remove Directory Assistant and reboot. Norton Utilities 3.0 and
  341.               later don't include Directory Assistant, by the way.
  342.       ----------------------------------------------------------------------
  343.       Q. You guys don't work in a vacuum. Surely there are people who have
  344.          been helpful when working on ramBunctious.
  345.       A. There are many people who have helped, and without whose assistance
  346.          we wouldn't be able to make ramBunctious the product it is.
  347.  
  348.             * Fawzi Dormeyer. Thanks for localizing ramBunctious to French,
  349.               but thanks even more for your enthusiastic help and hard work
  350.               overhauling ramBunctious's appearance.
  351.             * Chris Pethick. Thanks, Chris, for helping us grok some of the
  352.               innards of the ToolBox. You've helped us both concretely and
  353.               abstractly.
  354.             * Troy Gaul. Thanks for great-looking, easy-to-implement
  355.               windoids. Many Mac programs are better because of the freeware
  356.               Infinity Windoids.
  357.  -----------------------------------------------------------------------
  358.  
  359.                                  Glossary
  360.  
  361.   Chunk Size  Files can be accessed on RAM disks (or any media, for that
  362.               matter) in a variety of ways. "Chunk Size" refers to the
  363.               size of data accessed from the RAM disk. The smallest
  364.               possible chunk size is 512 bytes, or 1/2 K. The largest
  365.               theoretical chunk size is the size of the whole RAM disk!
  366.  
  367.               Sometimes the system chooses what the chunk size should
  368.               be, and sometime the application software decides. For
  369.               example, if the application software tries to read a file
  370.               one character at a time, the system reads 512 bytes and
  371.               remembers what's there when the application reads the next
  372.               character.
  373.  
  374.               On the other hand, an application can choose to read large
  375.               chunks, and these large chunk sizes are essentially the
  376.               chunk sizes seen by the RAM disk driver.
  377.  
  378.               Typically, larger chunk sizes lead to higher throughput,
  379.               since most of the time can be spent actually reading the
  380.               file instead of figuring out where on the RAM disk the
  381.               file is, and other overhead tasks.
  382.   Crippleware Many shareware programs are crippled in order to force
  383.               users to register before they have a full-featured
  384.               application. Other shareware programs force users to wait
  385.               a few extra seconds before they can begin using the
  386.               program. Still others present a dialog every time so users
  387.               will feel guilty enough to pay.
  388.   RAM disk    RAM disks are a convenient way to achieve high performance
  389.               in many applications. Hard drive accesses are hundreds of
  390.               times slower than memory accesses. RAM disks set aside an
  391.               amount of memory that the system can then use as a
  392.               "normal" hard drive, floppy drive, or any other storage
  393.               device -- except that they're much faster.
  394.  
  395.               Typical advantages of RAM disks include:
  396.  
  397.                  * The biggest advantage of RAM disks is speed. As
  398.                    mentioned above, memory accesses are much faster than
  399.                    hard drive, floppy disk, or network accesses.
  400.                  * Another advantage of RAM disks is small file
  401.                    overhead. In versions of the MacOS before 8.1, each
  402.                    file grows in increments of 1/65536 of the total hard
  403.                    drive size. In other words, even if a file is only a
  404.                    few characters long, on a one-gigabyte hard drive it
  405.                    will take up 16K! Since a RAM disk is typically a
  406.                    very small volume, the space lost to file allocation
  407.                    is minimized.
  408.                  * RAM disks can provide safety as well. Many people use
  409.                    RAM disks as web browser cache volumes for this
  410.                    reason. If the disk somehow becomes corrupted, then
  411.                    the damage is localized to the RAM disk and doesn't
  412.                    affect the system hard drive.
  413.                  * Security is a concern for many people. By using a RAM
  414.                    disk that is easily mounted and unmounted from the
  415.                    desktop, you can more easily isolate sensitive
  416.                    material. Note that using a RAM disk is no substitute
  417.                    for rigorous encryption; nevertheless, it can help
  418.                    prevent casual snoopers from digging through your
  419.                    material.
  420.  
  421.               Typical disadvantages of RAM disks include:
  422.  
  423.                  * Many RAM disk programs do not save the contents of
  424.                    the RAM disk to a file on a (real) disk. This means
  425.                    that crashes or power failures cause the contents of
  426.                    the RAM disk to be lost. Some RAM disks that do save
  427.                    the contents do so only when the RAM disk is put
  428.                    away. ramBunctious has a write-through feature
  429.                    available that saves the contents as soon as the RAM
  430.                    disk changes.
  431.                  * Most RAM disk programs only allow one RAM disk to be
  432.                    available at a time. If you have a RAM disk mounted,
  433.                    and realize that you have important information on
  434.                    another RAM disk, it can be frustrating to juggle RAM
  435.                    disks to access your information. ramBunctious allows
  436.                    you to mount as many RAM disks as you have memory
  437.                    for.
  438.                  * Many RAM disk programs require you to reboot before
  439.                    you can see the RAM disk. They also require you to
  440.                    reboot before you can reclaim the memory used by the
  441.                    RAM disk. ramBunctious uses the same memory that
  442.                    applications use, so it can create a RAM disk without
  443.                    rebooting, and you can reclaim memory used by the RAM
  444.                    disks instantly by putting them away.
  445.   Shareware   ramBunctious is a shareware program. That means you are
  446.               free to try it before you buy it. Shareware is basically
  447.               the honor system applied to software. If, after thirty
  448.               days, you find yourself using it, please pay for it.
  449.  
  450.               The honor system is particularly applicable to
  451.               ramBunctious, since it is not crippleware. Although we may
  452.               have increased registrations by implementing nagging
  453.               dialogs or removing functionality, we felt that our time
  454.               was better spent working directly on improving
  455.               ramBunctious.
  456.  
  457.               Prices for ramBunctious:
  458.                $12    single-user license
  459.               $100    site license
  460.               $350    world-wide license
  461.  
  462.               (All prices are in U.S. dollars)
  463.  
  464.  
  465.  -----------------------------------------------------------------------
  466.  
  467.                                  Legalisms
  468.  
  469.  Every effort was made to ensure that ramBunctious maintains data
  470.  integrity; furthermore, ramBunctious worked on every MacOS system we
  471.  tested. (These include the Mac SE, Classic II, LC II, Mac IIsi, Performa
  472.  630CD, Quadra 800, Quadra 840AV, PowerBook 5300, Performa 6290, PowerMac
  473.  7100/80, PowerMac 8100/80, PowerMac 9500/132, Power Computing 604e/200,
  474.  Mac G3, and MAE 2.1.)
  475.  
  476.  However, although we believe ramBunctious is stable and safe, there are
  477.  no guarantees: you use ramBunctious at your own risk. If you do find a
  478.  problem with the program, please report it to rambunctious@kagi.com.
  479.  
  480.  ramBunctious is copyright © 1995 - 1998 by Elden Wood and Bob Clark. It
  481.  is freely distributable, provided no more than a nominal copying fee is
  482.  charged for the media.
  483.  
  484.  Please send notification to rambunctious@clarkwoodsoftware.com if you
  485.  plan to include ramBunctious in any shareware collections or distribute
  486.  ramBunctious on CD. Permission will likely be granted.
  487.  
  488.  If the Software is licensed for use by the U.S. government, the user
  489.  agrees that the Software has been developed entirely at private expense
  490.  and is delivered as "Commercial Computer Software" as defined in DFARS
  491.  252.227-7013 or as "restricted computer software" as defined in FAR
  492.  52.227-19, as appropriate.
  493.  
  494.  No animals were harmed during creation of this product.
  495.